Doc/general edits #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Merged

akaszynski merged 56 commits into main from doc/general_edits

Sep 30, 2021

Member

PipKat commented Sep 29, 2021

There are several links using the format "ref:" followed by a single back tick and the file name. They are not working. I'd like to do more before creating the PR, but its 7:26 PM and my eyes are tired!

PipKat added 30 commits

September 29, 2021 14:28


          Update README.rst

9df1ced


          Update app_interface_abstraction.rst

4234d62


          Update data_transfer_and_representation.rst

c0fb44f


          Update index.rst

c6baee2


          Update service_abstraction.rst

398264e


          Update best_practices.rst

7bdc643


          Update data_transfer_and_representation.rst

da9002c


          Update best_practices.rst

a491601


          Create best_practices.rst

924864e


          Update flake8.rst

f7aa473


          Update index.rst

defb178


          Update class_documentation.rst

21da844


          Update coding_style.rst


          Update docstrings.rst

301300d


          Update index.rst

db80c51


          Update sample_func.py

0759cec


          Update ci_cd.rst


          Update ci_cd.rst

3d52980


          Update doc_directory.rst

88268ff


          Update index.rst

53a01cf


          Update index.rst

b8501a6


          Update index.rst

ce8262a


          Update index.rst

a70b34b


          Update index.rst

b3adac1


          Update library_names.rst

d6be072


          Update license.rst

791cdb1


          Update packaging.rst


          Update packaging.rst

318281e


          Update packaging.rst

ced8095


          Update packaging.rst

1abf9dc

akaszynski reviewed

View reviewed changes

doc/source/coding_style/best_practices.rst Outdated Show resolved Hide resolved

akaszynski reviewed

View reviewed changes

doc/source/coding_style/flake8.rst Outdated Show resolved Hide resolved

akaszynski reviewed

View reviewed changes

doc/source/coding_style/flake8.rst Outdated Show resolved Hide resolved

akaszynski reviewed

View reviewed changes

doc/source/coding_style/flake8.rst Outdated Show resolved Hide resolved

akaszynski reviewed

View reviewed changes

doc/source/coding_style/flake8.rst Outdated Show resolved Hide resolved

akaszynski reviewed

View reviewed changes

doc/source/library_description/source_organization.rst Outdated Show resolved Hide resolved

akaszynski reviewed

View reviewed changes

doc/source/overview/administration.rst Outdated Show resolved Hide resolved

akaszynski reviewed

View reviewed changes

doc/source/overview/administration.rst Outdated Show resolved Hide resolved

akaszynski reviewed

View reviewed changes

doc/source/overview/administration.rst Outdated Show resolved Hide resolved

akaszynski reviewed

View reviewed changes

doc/source/overview/contributing.rst

               develop your code and adhere to PyAnsys repository standards.
               Feature Requests
               ----------------
-              We encourage users to submit ideas for improvements to PyAEDT. To

Contributor

akaszynski Sep 30, 2021

Thanks for catching that!

akaszynski reviewed

View reviewed changes

doc/source/overview/contributing.rst Outdated Show resolved Hide resolved

akaszynski reviewed

View reviewed changes

doc/source/overview/contributing.rst Outdated Show resolved Hide resolved

akaszynski reviewed

View reviewed changes

doc/source/overview/dev_practices.rst Outdated Show resolved Hide resolved

akaszynski reviewed

View reviewed changes

doc/source/overview/dev_practices.rst Outdated Show resolved Hide resolved

akaszynski reviewed

View reviewed changes

doc/source/overview/dev_practices.rst Outdated Show resolved Hide resolved

akaszynski reviewed

View reviewed changes

doc/source/overview/dev_practices.rst Outdated Show resolved Hide resolved

akaszynski reviewed

View reviewed changes

doc/source/overview/dev_practices.rst Outdated Show resolved Hide resolved

akaszynski reviewed

View reviewed changes

doc/source/overview/dev_practices.rst Outdated Show resolved Hide resolved

akaszynski reviewed

View reviewed changes

doc/source/overview/dev_practices.rst Outdated Show resolved Hide resolved

akaszynski reviewed

View reviewed changes

doc/source/overview/dev_practices.rst Outdated Show resolved Hide resolved

akaszynski reviewed

View reviewed changes

doc/source/overview/dev_practices.rst Outdated Show resolved Hide resolved

akaszynski reviewed

View reviewed changes

doc/source/overview/dev_practices.rst Outdated Show resolved Hide resolved

akaszynski reviewed

View reviewed changes

doc/source/overview/dev_practices.rst Outdated Show resolved Hide resolved

akaszynski reviewed

View reviewed changes

doc/source/overview/dev_practices.rst Outdated Show resolved Hide resolved

akaszynski reviewed

View reviewed changes

doc/source/overview/dev_practices.rst Outdated Show resolved Hide resolved

akaszynski reviewed

View reviewed changes

doc/source/overview/dev_practices.rst Outdated Show resolved Hide resolved


          Apply suggestions from code review

b6a5947

Contributor

akaszynski commented Sep 30, 2021

Great work @PipKat, it really needed a thorough review.

akaszynski merged commit 0aeebca into main

akaszynski deleted the doc/general_edits branch

September 30, 2021 04:28

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet